Skip to content

New SPI invert hardware SS function in hall-spi and SPI library #11297

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

New SPI invert hardware SS function in hall-spi and SPI library #11297

wants to merge 6 commits into from
+20 −2

Conversation

UltimumControl
Copy link

This PR adds the ability to invert the logic level of the Hardware Slave Select (SS) pin for ESP32 SPI buses (HSPI/VSPI). This is critical for compatibility with hardware that expects active-high SS signals.

Backward Compatibility:
No breaking changes: Existing code using setHwCs() will default to invert_out=false (original behavior)
No Software SS Impact: Only affects hardware-controlled SS pins.
Isolation: Changes to one SPI bus (e.g., HSPI) do not affect others (e.g., VSPI).

Usage Example:
SPIClass *hspi = NULL;
setup(){
hspi = new SPIClass(HSPI);
hspi->begin();
hspi->setSSInvert(true); // Set before setHwCs();
hspi->setHwCs(true);
hspi->beginTransaction(SPISettings(SPI_CLOCK, MSBFIRST, SPI_MODE2));
}

I have tested my Pull Request on Arduino-esp32 core v3.1.3 with ESP32-S3 Board.

Related links

Some people have the same issue but with espidf. I use arduino ide so I fixed it for myself.
https://esp32.com/viewtopic.php?t=16057
https://esp32.com/viewtopic.php?t=16057

@CLAassistant
Copy link

CLAassistant commented Apr 25, 2025 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Apr 25, 2025 •
edited
Loading

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Add files via upload":
    • summary looks empty
    • type/action looks empty
  • the commit message "Add files via upload":
    • summary looks empty
    • type/action looks empty
  • the commit message "Update SPI.cpp":
    • summary looks empty
    • type/action looks empty
  • the commit message "Update SPI.h":
    • summary looks empty
    • type/action looks empty
  • the commit message "Update esp32-hal-spi.c":
    • summary looks empty
    • type/action looks empty
  • the commit message "Update esp32-hal-spi.h":
    • summary looks empty
    • type/action looks empty

Please fix these commit messages - here are some basic tips:

  • follow Conventional Commits style
  • correct format of commit message should be: <type/action>(<scope/component>): <summary>, for example fix(esp32): Fixed startup timeout issue
  • allowed types are: change,ci,docs,feat,fix,refactor,remove,revert,test
  • sufficiently descriptive message summary should be between 10 to 72 characters and start with upper case letter
  • avoid Jira references in commit messages (unavailable/irrelevant for our customers)

TIP: Install pre-commit hooks and run this check when committing (uses the Conventional Precommit Linter).

👋 Hello UltimumControl, we appreciate your contribution to this project!

📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.
🖊️ Please also make sure you have read and signed the Contributor License Agreement for this project.
Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against a9bb489

lucasssvaz
lucasssvaz reviewed Apr 25, 2025
View reviewed changes
Copy link
Collaborator

@lucasssvaz lucasssvaz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple nitpicks but otherwise LGTM.

cores/esp32/esp32-hal-spi.c Outdated
@@ -74,6 +74,7 @@ struct spi_struct_t {
int8_t miso;
int8_t mosi;
int8_t ss;
bool invert_out;
Copy link
Collaborator

@lucasssvaz lucasssvaz Apr 25, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would rename this to ss_invert or invert_ss to be more intuitive

cores/esp32/esp32-hal-spi.h Outdated
@@ -97,6 +97,8 @@ void spiSSSet(spi_t *spi);
void spiSSClear(spi_t *spi);

void spiWaitReady(spi_t *spi);
//invert hardware SS
void spiSSInvertout(spi_t *spi, bool invert);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you can remove the out of the function name. This will make it easier to read.

@lucasssvaz lucasssvaz added the Area: Libraries Issue is related to Library support. label Apr 25, 2025
P-R-O-C-H-Y
P-R-O-C-H-Y reviewed Apr 25, 2025
View reviewed changes
Copy link
Member

@P-R-O-C-H-Y P-R-O-C-H-Y left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree with Lucas's comments, otherwise looks good.

@UltimumControl
Update esp32-hal-spi.c
9d859c8 
renamed invert_out to ss_invert to be more intuitive
@UltimumControl
Update esp32-hal-spi.h
9f506aa 
Removed the out from the function name spiSSInvertout.
@UltimumControl
Update SPI.cpp
a9bb489 
Removed the out from the function name spiSSInvertout.
@UltimumControl
Copy link
Author

I made the recommended changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lucasssvaz lucasssvaz lucasssvaz left review comments

@P-R-O-C-H-Y P-R-O-C-H-Y P-R-O-C-H-Y left review comments

Assignees
No one assigned
Labels
Area: Libraries Issue is related to Library support.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@UltimumControl @CLAassistant @lucasssvaz @P-R-O-C-H-Y